home *** CD-ROM | disk | FTP | other *** search
/ Aminet 31 / Aminet 31 (1999)(Schatztruhe)[!][Jun 1999].iso / Aminet / util / boot / ForcePal.lha / ForcePal.doc < prev    next >
Text File  |  1998-02-13  |  14KB  |  342 lines
  1. ForcePal Documentation
  2. ----------------------
  3.  
  4. Author:   Ron Hackett
  5. EMail:    CC600750@ntu.ac.uk (till 2000ad)
  6. Snail:    12 Mount Pleasent
  7.           Golden Bank
  8.           Falmount
  9.           Cornwall
  10.           UK
  11.           TR11 5BW
  12. Revision: 1.0ß
  13. Date:     08/12/97
  14. Release:  CardWare/EMailWare/FreeWare
  15. DocVer:        1
  16. DocAuthor:Ron Hackett
  17.  
  18. Document Contentce
  19. ------------------
  20.  
  21.     Introduction
  22.     
  23.     Features (Why ForcePal)
  24.     
  25.     Requirements
  26.     
  27.     Installation
  28.     
  29.     Operation/Use
  30.     
  31.     Definition of a Prefs file
  32.     
  33.     Unintended Features
  34.     
  35.     To Do
  36.     
  37.     Legal
  38.  
  39.     Author
  40.  
  41. Introduction
  42. ------------
  43. ForcePal is a utility to ensure that you know what palette your system is
  44. using, at least at start up time. I havn't included any code to lock these
  45. colours or force them to stay this colour, all I can say is that I've been
  46. using it for several months now and nothing has attempted to change the
  47. colours ForcePal sets up. The only trouble I have is if the Workbench screen
  48. is closed and re-opened again. Why? ForcePal is not a resident program and
  49. sould therefore be run each time the Workbench screen is opened.
  50.  
  51. This current version of ForcePal (1.0ß) and it's documentation are still
  52. very much in the form of a beta. Notice the source comments that it will
  53. probably crash the system if some idiot tries to give it an icon and run it
  54. from Workbench. This is because it is a CLI program and expects to recieve
  55. some form of command line parameters. (even if they are empty it should just
  56. recieve a null) This means it should work from IconX, IconJ, DoIcon or the
  57. Execute Command Menu option from Wrokbench. Just don't give it a Tool Icon!
  58.  
  59. It can of course be launched from a Dock or menu enhancer as long as the
  60. environment emulation for that option is set to CLI NOT WORKBENCH. Infact I
  61. havn't been stupid enough to try running it from Workbench yet but I've seen
  62. the results of other previous experiments and they wern't pretty!
  63.  
  64. Features (Why ForcePal)
  65. -----------------------
  66.  
  67. - CLI based
  68. - Non detatchable
  69. - Small
  70. - Accepts command parameters
  71. - Preferance file in ASCII
  72. - No resident portion
  73. - Terminates almost instantly
  74. - Performs NO colour locking
  75. - Version String               *** NEW for V1.0ß*** :-)
  76.  
  77. This means it works very well with NewIcons and very badly with MUI, sorry.
  78. See to do.
  79.  
  80. Requirements
  81. ------------
  82.  
  83. As far as I know you will need an Amiga or Amiga Compatible computer. And
  84. that's about it. It should run under Amiga OS 1.3, maby even 1.2 but I
  85. don't have the later and the former is back at home, Will check at
  86. Christmas.
  87.  
  88. Installation
  89. ------------
  90. Well it's a CLI utility isn't it. I segest sticking it in `c:' or somewhere
  91. else in your PATH. I use `system:xc' which is c: with `system:c' ADDed to
  92. it. I run it from `s:Startup-sequence' before and after LoadWB ensureing
  93. the palette is set up when Workbench starts and pushing the colours back if
  94. it has tried to change anything.
  95.  
  96. Operation/Use
  97. -------------
  98. I recomend that it is placed late in your s:startup-sequence or
  99. s:user-startup. How late...? Considerably later than IPrefs for aesthetic
  100. reasonning. Why...? ForcePal has to temporarily open a Window on the
  101. Workbench screen, to link it's palette with that of the Workbench, this will
  102. open the Workbench screen. Don't worry you won't ever notice this window,
  103. it's exactly 1 pixel in size and sits right up in the top left hand corner of
  104. the screen for only a fraction of a  second.
  105.  
  106. By default (and having done only this) ForcePal will simply patch the second
  107. 4 colours (those from 4 to 7) to resemble the MagicWorkbench palette. Some
  108. may say this is an essential enough task and of course quite necessary but
  109. this was not the only intention. Even in the early days when this program
  110. was called ForceMWBPal it was asspiring to be so much more. (When I could
  111. get round to coding it) It now features a symple prefs file (prefs editor to
  112. be coded in near future, don't go you can get by without) in ASCII format
  113. stored (by default) in the s: assign so it dosen't take up RAM: in ENV: and
  114. a set of two (yes kids you heard it hear first TWO) command line parameters!
  115. Please bare in mind that these command line parameters are the most recent
  116. additions to ForcePal and are likely to be a little unstable. Notealby these
  117. parameters must be issued (or not, as the case may be) in the correct order!
  118.  
  119. They are:-
  120. -NOMWB!!!
  121.         This increadable feature enables you NOT to set the MagicWorkbench
  122. Palette with ForcePal. The bonous feature of this is that if you have no
  123. Prefs file... ForcePal dose absoulutly nothing at all. (Except open a window,
  124. waste some processor time, close a window and take up room on your hard disk)
  125. :-)
  126.  
  127. <filename>
  128.         With this cunning feature you can specify a different Prefs file from
  129. the default one. But wait that's not all. If ForcePal couldn't find your
  130. specified Prefs file... It uses the default Prefs file!!!(Raptuious applause)
  131. This of cource means you can have lots of different palettes set up and use
  132. different ones for different moods! combined with something like RandomFile
  133. you could even have a different palette every time you boot. A predominantly
  134. blue one one day and a predominently green one the next for instance. I
  135. hasten to add that I have never been so gross as to attempt this and I guess
  136. that even without this feature one could get round the problem. But for me
  137. it dose enable me to set up the palette for Iconographics when I'm in
  138. Iconographics dominated directories, MagicWorkench, UberBench, FreshIcons
  139. etc. BTW I recently noticed that the FreshIcon Palette only differs from the
  140. Acorn Risc OS 16 colour palette in respect of two colours and the positions!
  141. Cool huh?
  142.  
  143. Full Command Spec:-
  144.     ForcePal [[-NOMWB] <PrefsFile>]
  145.  
  146. Definition of a Prefs file
  147. --------------------------
  148. The default prefs file should be s:ForcePal.Prefs and contain any number of
  149. lines. On each line should be four numbers seperated by commas. There MUST
  150. be no blank lines and as yet comments are NOT supported. The first number is
  151. the position at which the colour is to be set. The remaining four are an 8
  152. bit decimal number refering to the gun intencity of the red, green, and blue
  153. attributes of that position in the CLUT. eg.
  154.  
  155. 0,170,170,170
  156. 1,0,0,0
  157. 2,255,255,255
  158.  
  159. Will force the first three colours to be their default colours as set in the
  160. Kickstart from 2.04 onwards. Grey, black and white. For maximum blue in the
  161. fourth colour:-
  162. 3,0,0,255
  163.  
  164. red:-
  165. 3,255,0,0
  166.  
  167. for Green:-
  168. 3,0,255,0
  169.  
  170. and so on. Another stunning advantage of this program is that you can set
  171. the colours of the upper end of your palette by appending a minus `-'. If
  172. you had an 8 plane Workbench (256 colours) and had a line:-
  173.  
  174. -1,255,255,0
  175.  
  176. then colour number 255 would be bright yellow. This would not be very
  177. advantagious as the OS sets the top 4 colours but you could set
  178.  
  179. -5,255,255,0
  180.  
  181. and this will set the first colour below the top four that the OS sets to be
  182. bright yellow. This means of course that if you decrease your Workbench
  183. colours to 64 colour 59 will be set to bright yellow instead of colour 251.
  184.  
  185. To Do
  186. -----
  187.  
  188. It may be that I don't do anything else with this 1.0ß may well be the only
  189. released version. Espesially if I get no responses. However it is running
  190. in my system and I have a few ideas. In order of priority.
  191.  
  192. - Remove any bugs people find!?
  193. - Add Prefs Program
  194. - Improve Parameter Parsing
  195. - Add `?' Parameter
  196. - Add Comment Recognition in Prefs file
  197. - Test and add Workbench compatability
  198.         Tool Types instead of parameters etc
  199. - Add OPTIONAL Colour Locking
  200.  
  201. Unintended features
  202. -------------------
  203. MUI programs opened on the Workbench screen mess the palette up something
  204. cronic.
  205.  
  206. I havn't had any crashes for ages. Thigs I would say will stuff ForcePal
  207. up goo and proper would include giving funny parameters to it like:-
  208.  
  209.     ForcePal ?
  210.  
  211. Seems sencible enough, it'll probably look for a file called ? as its
  212. prefs and go belly up coz it can't find it. Giving strange lines in the
  213. Prefs file will freak it out for sure. It reads 4 ASCII numbers from the
  214. file at a time delimited by a <LF> or a comma `,' so
  215.  
  216. 0
  217. 0
  218. 0
  219. 0
  220.  
  221. and
  222.  
  223. 0
  224. 0,0,0
  225.  
  226. and
  227. 0,0,0,0
  228.  
  229. are all the same as far as ForcePal is concerned, but only the last is very
  230. readable. What will cause problems